home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #14 / Monster Media No. 14 (April 1996) (Monster Media, Inc.).ISO / bbs_game / ox2v3wb3.zip / SYSOP.DOC < prev    next >
Text File  |  1996-02-19  |  48KB  |  987 lines
  1.                   IRON OX Version 3.00 wide beta three
  2.        (C)opyright 1995, Joel W. Downer (Development in Progress)
  3.  
  4.           Support BBS:  Fido 1:202/704, 619-462-8406/462-7146
  5.                    Inquiries:  joel@dreamcty.cts.com
  6.  
  7.                                 CONTENTS
  8.  
  9. This documentation file includes the following sections:
  10.  
  11. SUMMARY                          What this door is and why you want it!
  12. EVALUATION VERSION               Shareware notice; evaluation terms
  13. COMPATIBILITY/REQUIREMENTS       What you need to run this program
  14. INSTALLING THE GAME              How to get the game running
  15. TRYING OUT THE GAME              How to take a look at this door
  16. IRON OX AND YOUR BBS             Getting the game working from your BBS
  17. COMMAND-LINE ARGUMENTS           List of options accepted by the program
  18. MULTINODE SETUP                  Special issues for multinode sysops
  19. COMMON PROBLEMS                  Please read *before* calling me at 3 AM <g>
  20. CONFIGURING IRON OX              Customizing your IRONOX.CFG file
  21. EXTERNAL PROTOCOLS               Setting up external protocols with Iron Ox
  22. MAINTAINING IRON OX              To keep the door running over time...
  23. CUSTOMIZING                      Touching up the program to your taste
  24. ERRORLEVELS                      Information for tech geek sysops <g>
  25. LICENSE/REG. INFORMATION         How to register your copy of Iron Ox!
  26. ADDITIONAL LICENSE INFO          Info on distributing/licensing this door
  27. SUPPORT                          Where to get more help!
  28. DISTRIBUTION SITES               Where to find the latest version.
  29. OTHER SOFTWARE BY JOEL DOWNER    If you like Iron Ox....
  30. DISCLAIMER                       Boilerplate courtesy of legal dept. <g>
  31. ACKNOWLEDGEMENTS                 The names of a few heroes/heroines
  32.  
  33.                                 SUMMARY
  34.  
  35. Iron Ox is an interactive strategy game intended to be run as a BBS
  36. external program (door).  The players have been sent against their will
  37. to an untamed alien world:  they start with their bare hands, a few
  38. automated "iron oxen" to help them build things, and a small pack of
  39. cybernetically modified dogs ("cybermutts") to protect them.  Will your
  40. callers work together to master the world and build a flourishing
  41. civilization, with roads and freeways and a powerful economy?  Or will
  42. they destroy each other and the planet beneath their feet as they
  43. struggle for dominance?  And what about neighboring worlds?  Rumors brew
  44. that the other colonies are building armies ... if war erupts, will your
  45. BBS's callers be ready?
  46.  
  47. Iron Ox is a rich game, with exciting features like:
  48.  
  49. * RIP graphics support, with beautiful art and (optional) local RIP!
  50. * five-minute setup with a one-line batch file on most systems,
  51. * detection and timeslicing for DESQview, Windows, and OS/2,
  52. * full multinode support, with real-time chat, messaging, and combat!
  53. * support for a wide variety of door drop files (including DOOR.SYS,
  54.   DORINFO?.DEF, EXITINFO.BBS, CHAIN.TXT, CALLINFO.BBS, and SFDOORS.DAT),
  55. * support for direct serial communications or FOSSIL,
  56. * a native, 32-bit OS/2 version available, and
  57. * full InterBBS league support, including IBBS attacks and ops!
  58.  
  59.                           EVALUATION VERSION
  60.  
  61. Iron Ox is distributed in an evaluation version, intended for you to try
  62. out for thirty days.  The evaluation version of Iron Ox is a complete
  63. and (I hope) enjoyable game.  If you like Iron Ox and wish to continue
  64. using it after thirty days, please see "LICENSING/REGISTRATION
  65. INFORMATION," below, for details on how to register.  A registration key
  66. for Iron Ox will enable additional features that will make the game even
  67. more exciting for your users.
  68.  
  69. Thanks for evaluating Iron Ox!
  70.  
  71.                        COMPATIBILITY/REQUIREMENTS
  72.  
  73. The DOS version of Iron Ox requires about 375k of memory to run in text
  74. mode, and about 435k to run with local graphics.  (Having more memory,
  75. and some EMS memory available, will make it run faster.)
  76.  
  77. Running Iron Ox in graphics mode (with the /LRIP parameter) requires a
  78. monitor with EGA or better graphics support.  The game will work fine on
  79. any sort of monitor running without the /LRIP parameter.  Local graphics
  80. will work under DESQview and other DOS multitaskers, but using graphics
  81. on multitasking multinode systems is not recommended.  In particular,
  82. having two or more sessions on one machine trying to do local graphics
  83. at the same time is a bad idea.
  84.  
  85. Iron Ox (for DOS or OS/2) requires a minimum of 1.5 megabytes of disk
  86. space.  When running with local graphics, it may consume another
  87. 200-350k of space for temporary icon storage.  A hard disk is required.
  88.  
  89. Iron Ox for DOS runs under (and gives up timeslices to) DESQview,
  90. Windows, and OS/2.  (If you're running OS/2, though, you'll probably
  91. want Iron Ox for OS/2.)
  92.  
  93. Iron Ox for DOS includes internal comm routines, with support for
  94. non-standard IRQ's and for rates of up to 115Kbps, as well as support
  95. for a FOSSIL driver.  Support for some specialized requirements
  96. (DigiBoards, shared IRQ's) is provided in the DOS version through the
  97. FOSSIL standard.  Recent versions of several popular FOSSIL drivers are
  98. available through the support BBS.  If you're running the OS/2 version
  99. of the door, don't worry about any of these issues:  your device driver
  100. will take care of them.
  101.  
  102. Iron Ox requires that the remote user (your caller) have ANSI, AVATAR,
  103. or RIP graphics, but does not require special drivers on the sysop end.
  104.  
  105.                           INSTALLING THE GAME
  106.  
  107. This section describes how to set up Iron Ox in single-BBS mode.  If
  108. you're setting up Iron Ox for interBBS league play, see INTERBBS.DOC for
  109. instructions.
  110.  
  111. Here's what it takes to install Iron Ox:
  112.  
  113. 1. Unpack the Iron Ox archive into its own directory (all of the
  114.    examples in this .DOC file assume you've used C:\DOOR\IRONOX, but any
  115.    directory will do).
  116.  
  117. 2. Run INSTALL.BAT (INSTALL.CMD under OS/2) and follow the instructions
  118.    that appear on the screen.  (In case you want to recreate these steps
  119.    manually, INSTALL.BAT/INSTALL.CMD runs OxConfig to create your
  120.    configuration file and your batch file and then runs IRONOX /LOCAL
  121.    /RESET to create a new Iron Ox game.)
  122.  
  123. 3. Be sure to say "Yes" to the questions about saving your configuration
  124.    file and creating a new game.  Otherwise, though, you can mostly just
  125.    accept all the defaults at this point.  (You can always go into
  126.    OxConfig later and fine-tune your configuration.)  If you have an
  127.    external protocol like DSZ (DOS) or CEXYZ/2 (OS/2) installed, be sure
  128.    to visit General Settings|General Config in OxConfig and set the
  129.    pathname for your external protocol so Ox can automatically send RIP
  130.    icon files to RIP terminal users.
  131.  
  132. At the end, the installation process displays some instructions on the
  133. screen about adding Iron Ox to your BBS.  You can follow those
  134. instructions now, or wait until you've "previewed" Ox as described in
  135. the next section.
  136.  
  137.                           TRYING OUT THE GAME
  138.  
  139. Iron Ox is at its best with multiple players.  However, if you like to
  140. get acquainted with a game before offering it to your callers, you can
  141. easily play a few turns on your own to see what it feels like.  After
  142. you've set up the game as described under "INSTALLING THE GAME," above,
  143. just access the game locally by typing:
  144.  
  145.    C:\IRONOX>IRONOX -LOCAL
  146.  
  147. If you're running the DOS version of Iron Ox and you have an EGA monitor
  148. or better, you can have graphics by using this command-line instead:
  149.  
  150.    C:\IRONOX>IRONOX -LOCAL -LRIP
  151.  
  152. The first time you run the game, it will bring up a screen including
  153. lots of reset options; for a quick look, just accept the defaults.
  154.  
  155. When you're done playing a turn, you can advance to a new turn using:
  156.  
  157.    C:\IRONOX>IRONOX -MAINT
  158.  
  159.                           IRON OX AND YOUR BBS
  160.  
  161. If you've gotten this far, I assume that you liked what you saw when you
  162. followed the "TRYING OUT THE GAME" instructions.  Great!  Now, let's get
  163. Iron Ox working as a door on your BBS.
  164.  
  165. This section includes three subsections:  getting Ox for DOS to work
  166. with a DOS BBS, getting the OS/2 version to work with an OS/2 BBS, and
  167. using the OS/2 version with a DOS BBS running in the OS/2 DOS box.
  168. (Whew!  That was a mouthful. <g>)  Make sure you understand which
  169. situation applies to you and that you have the right version for your
  170. operating system, because the differences are important.
  171.  
  172.    Iron Ox for DOS and a DOS BBS:
  173.  
  174. Here are the key steps to installing Iron Ox for DOS:
  175.  
  176. 1. Create a batch file your BBS can use to start the door.  The easiest
  177.    way to do this is to use the "Make Batch File" option in OxConfig.
  178.  
  179.    If you need to build a batch file manually from scratch (say, because
  180.    the one OxConfig creates isn't working for you), start with this:
  181.  
  182.    C:\DOOR\IRONOX\IRONOX.EXE
  183.  
  184.    If you want local RIP graphics and you have an EGA monitor or better,
  185.    it'll look more like this:
  186.  
  187.    C:\DOOR\IRONOX\IRONOX.EXE -LRIP
  188.  
  189.    If you are running a multinode DORINFOx.DEF BBS, if your BBS doesn't
  190.    launch door execution from the same directory where it creates
  191.    dropfiles (Maximus often doesn't), or if you're using a non-standard
  192.    comm port under DOS and aren't running a FOSSIL driver, you'll need
  193.    to use additional command-line parameters.  See the file SAMPLE.BAT
  194.    for examples, or the section below on "COMMAND-LINE ARGUMENTS" for
  195.    detailed explanations.
  196.  
  197.    Advice:  Keep it simple.  Assume that you don't need to use extra
  198.    command-line arguments unless you have special reason to think
  199.    otherwise.  The above one-line batchfile will work for a vast
  200.    majority of systems, and making things more complex (copying the
  201.    dropfile to the game directory, changing directories, etc.) will
  202.    often introduce problems instead of avoiding them.
  203.  
  204. 2. Add lines to your nightly maintenance file to run Ox maintenance on a
  205.    daily basis.  Depending on your directory structure, the lines might
  206.    look like this:
  207.  
  208.    C:
  209.    CD\DOOR\IRONOX
  210.    IRONOX /MAINT
  211.  
  212.    If you have activated any bulletins in OxConfig, you will also want
  213.    to add a line like this to update the bulletins:
  214.  
  215.    IRONOX /BULLETINS
  216.  
  217.    You may choose to add IRONOX /BULLETINS to the batch file that runs
  218.    the game -- so that bulletins are updated whenever a player exits the
  219.    game -- but be aware that writing a complete set of bulletins,
  220.    including interBBS bulletins, may be somewhat slow (it takes about 5
  221.    seconds, for instance, on my 486-100).
  222.  
  223. That's all it takes!  You're ready to add Iron Ox to your door menu and
  224. get rolling!
  225.  
  226.    Iron Ox for OS/2 for a Native OS/2 BBS:
  227.  
  228. Here are the key steps to installing Iron Ox for OS/2:
  229.  
  230. 1. Copy the file DRS2V5B5.DLL to a directory on the LIBPATH defined in
  231.    your CONFIG.SYS.  On a typical system, the \OS2\DLL directory on your
  232.    boot drive works fine.
  233.  
  234. 2. Create a batchfile or script to run the game.  If you're running
  235.    Maximus or a similar BBS system, no batchfile is necessary:  you can
  236.    add a script directly to your MENUS.CTL file.  See below for
  237.    examples.
  238.  
  239. 3. Add lines to your nightly maintenance file to run Ox maintenance on a
  240.    daily basis.  Depending on your directory structure, the lines might
  241.    look like this:
  242.  
  243.    C:
  244.    CD\DOOR\IRONOX
  245.    IRONOX /MAINT
  246.  
  247.    If you have activated any bulletins in OxConfig, you will also want
  248.    to add a line like this to update the bulletins:
  249.  
  250.    IRONOX /BULLETINS
  251.  
  252.    You may choose to add IRONOX /BULLETINS to the batch file that runs
  253.    the game -- so that bulletins are updated whenever a player exits the
  254.    game -- but be aware that writing a complete set of bulletins,
  255.    including interBBS bulletins, may be somewhat slow (it takes about 5
  256.    seconds, for instance, on my 486-100).
  257.  
  258. Here's a script that will work fine on a single-node system using the
  259. default DORINFO.MEC script that comes with Maximus:
  260.  
  261.       Display_File   C:\Max\Misc\Dorinfo           Normal "Iron Ox/2"
  262. NoDsp Xtern_Dos      C:\Door\IronOx\IronOx.exe     Normal "I"
  263.  
  264. Important question:  Have you changed your DORINFO.MEC script to write
  265. the name of the correct comm port to the dropfile instead of the number
  266. of an open comm handle?  (Many OS/2 sysops who run DOS doors have done
  267. this.)  If so, your script should look like this:
  268.  
  269.       Display_File   C:\Max\Misc\Dorinfo              Normal "Iron Ox/2"
  270. NoDsp Xtern_Dos      C:\Door\IronOx\IronOx.exe_/PORT  Normal "I"
  271.  
  272. Note:  If you get errors accessing the port with this configuration,
  273. make sure you have your serial driver configured to allow a comm port to
  274. be shared across sessions (with SIO, you would need to use the "-"
  275. parameter, described in the section on running from a VDM).
  276.  
  277. Are you running multinode?  If so, copy MLTINODE.MEC (from this archive)
  278. to your scripts directory, and use the following commands to run Iron
  279. Ox/2:
  280.  
  281. Display_File   Misc\MltiNode                    Normal "Iron Ox/2"
  282. NoDsp Xtern_Dos \Door\IronOx\OX.cmd_%k          Normal "I"
  283.  
  284. OX.CMD should look like this:
  285.  
  286. C:\DOOR\IRONOX\IRONOX.EXE /N:%1 C:\MAX\MISC\%1\
  287.  
  288. Note:  For this setup to work, you will need to create node work
  289. directories under \MAX\MISC\ for each node, like so:
  290.  
  291. C:\MAX\MISC\1\ (for node 1)
  292. C:\MAX\MISC\2\ (for node 2), and so forth.
  293.  
  294. Another note:  Depending on the configuration of your system, you may
  295. wish to try using the /NICE parameter.  See the section on command-line
  296. arguments, below.  You should only need to consider using the /NASTY
  297. parameter if you run a multinode BBS and your users spend a lot of time
  298. in ill-behaved DOS doors.
  299.  
  300.    Installing Iron Ox for OS/2 for a DOS BBS in a VDM:
  301.  
  302. If you are running a DOS BBS under OS/2, you should be able to take
  303. advantage of the enhanced features and performance of Iron Ox for OS/2.
  304. I am now running my DOS BBS full-time under OS/2, so compatibility has
  305. been a high priority for me from the beginning.  Your mileague running
  306. an OS/2 door under a DOS BBS may vary (some people report impressive
  307. results, while others notice little difference), but I hope you'll be
  308. glad to have the choice. :-)
  309.  
  310. To run Ox/2 from a DOS BBS, you must be using Ray Gwinn's SIO or
  311. compatible drivers (COM.SYS/VCOM.SYS will not work).  Recent versions of
  312. SIO, working with OS/2 2.1x and above, will allow OS/2 and DOS sessions
  313. to share a comm port.  SIO must be loaded with the "-" parameter, which
  314. allows port-sharing, and you must have the "Share comm port with OS/2
  315. Sessions" option turned on in the DOS Sessions Settings for the session
  316. in which you run your BBS.
  317.  
  318. To spawn OS/2 sessions from your DOS BBS, you will need OS2EXEC or a
  319. similar utility.  OS2EXEC creates OS/2 sessions that wait on commands
  320. from DOS sessions; you run the door by telling OS2EXEC to execute
  321. IRONOX.EXE.
  322.  
  323. Both OS2EXEC and SIO are available for FREQ and download from my BBS;
  324. see the section on "SUPPORT," below.
  325.  
  326. So, with requirements and caveats stated, let's get to batch files and
  327. configuration information.  First of all, I have a startup .CMD file as
  328. follows:
  329.  
  330. REM Start "Daemon" sessions for each of my three BBS nodes
  331. START /FS OS2EXECD
  332. START /FS OS2EXECD
  333. START /FS OS2EXECD
  334. REM End of startup .CMD
  335.  
  336. My Wildcat! batch file is very straightforward:
  337.  
  338. OS2EXEC C:\DOOR\IRONOX\IRONOX.EXE /PORT
  339.  
  340. If you are running a DORINFO system, you may need to use the /N
  341. parameter.  If Ox has trouble finding your dropfile, you may need to
  342. specify it on the command line.  See the general installation
  343. instructions, above, and the information on command-line arguments,
  344. below.
  345.  
  346. If you run a multinode system with high-speed lines and/or
  347. non-timeslicing comm software (in other words, if there are other tasks
  348. that eat up lots of CPU time when players will be in Iron Ox) you may
  349. need to try the /NASTY parameter.  See the section on command-line
  350. parameters, below.
  351.  
  352.                          COMMAND-LINE ARGUMENTS
  353.  
  354. Iron Ox supports a number of command-line parameters.  If the
  355. documentation for any of these makes your eyes glaze over, your best bet
  356. is to skip over to the next one.  Chances are that if you don't
  357. understand it, you also don't need it.
  358.  
  359. /ACCEPT      This option tells Iron Ox not to mess with the
  360.              communications parameters currently set for your comm port
  361.              -- to open the port (or the FOSSIL driver, if appropriate)
  362.              as it stands.  It is intended to help people whose systems
  363.              do not respond correctly when a door program attempts to
  364.              reset communications parameters.  Advice:  Assume you
  365.              *DON'T* need this option unless the game doesn't work
  366.              without it.  (Note:  This option has no effect under OS/2.)
  367.  
  368. /BULLETINS   Updates any bulletin files you have activated in OxConfig.
  369.  
  370. /LOCAL       This option tells Iron Ox to run in local mode, and not to
  371.              access the comm ports or look for a BBS dropfile.  By
  372.              default, when running in local mode, Ox assumes it is
  373.              running on node 0.  If you are running a multinode system
  374.              and want to run on a different node number, use the /N
  375.              option documented below.
  376.  
  377. /LOCK        This option allows you to lock the bps rate Iron Ox uses to
  378.              communicate with your modem to a speed other than the one
  379.              specified in your door information file.  Example:
  380.  
  381.              IRONOX /LOCK:19200
  382.  
  383.              This option is only effective if you are using the internal
  384.              comm system (port-locking for FOSSIL drivers should be
  385.              controlled through FOSSIL driver setup).  (Note:  This
  386.              option has no effect under OS/2.)
  387.  
  388. /LRIP        This option tells Iron Ox to run in graphics mode using the
  389.              same RIPScrip graphics a caller will see if he/she logs in
  390.              using a RIP terminal (like RIPTerm or QMPro).  Notes:
  391.  
  392.              (a) Local graphics are currently not supported in the OS/2
  393.                  version of Iron Ox.  (They are a possibility for an
  394.                  upcoming version -- let me know if it's a feature you
  395.                  want to see!)
  396.  
  397.              (b) When you're not running in local mode (i.e., you aren't
  398.                  using the /LOCAL parameter), the game will only run
  399.                  with local graphics when the remote user (the caller)
  400.                  also has RIP graphics.  In other words, if the caller
  401.                  only has ANSI, you see ANSI with or without /LRIP.
  402.  
  403.              (c) If you run more than one node under a multitasker like
  404.                  DESQview, you will probably want to ensure that only
  405.                  one copy of Iron Ox is running in /LRIP mode at a time.
  406.                  If multiple instances of the game try to access the
  407.                  graphics display at once, screen corruption can result.
  408.  
  409. /MAINT       This option runs daily maintenance, advancing the game to a
  410.              new turn.  It may not be run when the game is in use on
  411.              another line, so IRONOX /MAINT is a good candidate for your
  412.              nightly maintenance event.  Running IRONOX /MAINT *more*
  413.              than once a day (for a faster-moving game) works fine in
  414.              single-BBS mode; it's disabled in interBBS league mode to
  415.              prevent cheating.
  416.  
  417. /N:          This option allows you to indicate the current node number
  418.              when the game is run on a multinode system.  Example:
  419.  
  420.              IRONOX /N:3
  421.  
  422.              On most systems, the node number is included in the door
  423.              drop file and this option is not needed.  The most common
  424.              systems where you *will* want to use this option are
  425.              DORINFO BBS packages like RemoteAccess.
  426.  
  427. /NASTY       Systems running OS/2 BBS'es can be gentle and friendly
  428.              places where all software cooperates and shares the CPU;
  429.              others can be war zones where CPU-hungry DOS doors starve
  430.              the rest of the system. The /NASTY parameter warns Iron Ox
  431.              that it's running in one of those "war zones," and that it
  432.              needs to set its thread priorities very high to compete
  433.              with the "bullies."
  434.  
  435.              You should probably not use this parameter unless you get
  436.              complaints about Iron Ox running very slowly and/or you
  437.              know you run lots of non-timeslicing DOS doors.
  438.  
  439.              (Note:  This option has no effect in the DOS version.)
  440.  
  441. /NICE        The /NICE parameter is the natural counterpart of the
  442.              /NASTY parameter, documented above.  Using the /NICE
  443.              parameter indicates to Iron Ox that it's running in a
  444.              friendly environment and that it can rely on CPU idle time
  445.              to do things like refresh the screen and dump output to the
  446.              comm driver.
  447.  
  448.              On all-native systems or single-node systems with a light
  449.              CPU load, using /NICE should make for better performance
  450.              with substantially less CPU load.  This option is almost
  451.              guaranteed, however, to provide miserable performance on
  452.              multinode systems running DOS BBS software and/or
  453.              non-timeslicing DOS doors.
  454.  
  455.              Note:  By default, Iron Ox is neither /NICE nor /NASTY:  it
  456.              uses moderate thread priorities.  Many sysops will need
  457.              neither the /NICE nor the /NASTY parameter; the parameters
  458.              are included to give sysops control over game performance.
  459.  
  460.              (Note:  This option has no effect in the DOS version.)
  461.  
  462. /NOFIFO      Some Western Digital 16550 cards have a bug that causes
  463.              them to lock up when their FIFO buffers are used.  This
  464.              flag tells Iron Ox to disable its use of FIFO buffers.
  465.              Note:  If you've never heard of this FIFO bug before,
  466.              assume it *DOESN'T* apply to you and do not use this
  467.              option!  If you had the problem, you'd know by now. <g>
  468.  
  469.              (Note:  This option has no effect under OS/2.)
  470.  
  471. /NOFOSSIL    If you *have* a FOSSIL driver, but do *not* wish to use it,
  472.              this flag will tell the game to ignore the driver and use
  473.              internal comm instead.  This option may be useful if you
  474.              are having problems with Iron Ox's FOSSIL support.  Note:
  475.              If you do not have a FOSSIL, you do not need this option --
  476.              Iron Ox will automatically default to internal comm if it
  477.              does not find a FOSSIL.  (Note:  This option has no effect
  478.              under OS/2.)
  479.  
  480. /P, /I       These options allow you to set the hexadecimal base address
  481.              and the IRQ number for a non-standard serial port.  Example:
  482.  
  483.              IRONOX /P:3F8 /I:4
  484.  
  485.              indicates that the game should use base address 3F8h, and
  486.              IRQ4 for serial I/O.  These arguments are *ONLY* needed if
  487.              you are using internal serial support; they are ignored if
  488.              you have a FOSSIL installed and have not used the /NOFOSSIL
  489.              argument.  Note:  The AT IRQ lines (9-15) are *NOT*
  490.              supported using these arguments.  Support for the AT IRQ's
  491.              is only available through a FOSSIL driver.
  492.  
  493.              (Note:  This option has no effect under OS/2.)
  494.  
  495. /PLANETARY   This option runs interBBS planetary maintenance:  it
  496.              packs up all outbound information waiting to go to other
  497.              systems, processes any inbound packets from other systems,
  498.              and (if enough time has passed since the last planetary
  499.              maintenance) creates recon information packets from other
  500.              systems.  Running IRONOX /PLANETARY has no effect on a game
  501.              that isn't part of an interBBS league.
  502.  
  503.              This option may be run any number of times per day, and
  504.              works fine if run with a user on another node.  It should
  505.              not be used in conjunction with /RESET or /MAINT.
  506.  
  507. /RESET       This option tells Iron Ox to purge the current game and
  508.              brings up the "create new game" menu.
  509.  
  510.              Note:  Do not use this option while people are playing the
  511.              game on another node.
  512.  
  513. [pathname]   By default, Iron Ox looks for a door drop file in the
  514.              current directory -- it expects to be run from the node
  515.              work directory, as described above.  Also by default, it
  516.              will autodetect which dropfile to use by checking the
  517.              directory for the most current dropfile it supports (i.e.,
  518.              it does freshness-testing to avoid using stray dropfiles).
  519.  
  520.              You can specify the path where Iron Ox should look for its
  521.              dropfile and (if necessary) the name of the dropfile to
  522.              use.  Thus:
  523.  
  524.              C:\DOOR\IRONOX\IRONOX.EXE C:\WC30\WCWORK\NODE1\
  525.  
  526.              or, alternatively
  527.  
  528.              C:\DOOR\IRONOX\IRONOX.EXE C:\QBBS\DORINFO3.DEF
  529.  
  530.              Note:  This command-line option is usually not necessary.
  531.  
  532.                          MULTINODE SETUP
  533.  
  534. Iron Ox was written and tested from the ground up to run multinode.  In
  535. general, multinode setup is *identical* to single-node setup:  All nodes
  536. use the same configuration file, and (for the most part) they can use
  537. the same batch file, too.  Because the program supports FOSSIL drivers
  538. under DOS and uses the standard device driver model under OS/2, it can
  539. handle issues like non-standard IRQ's *completely automatically* -- no
  540. need to treat individual nodes specially on FOSSIL or OS/2 systems.
  541.  
  542. Multiple players can use this door at the same time; Iron Ox
  543. handles all file locking internally.  (Note:  The file-locking system
  544. supports node numbers up to about 1,000 -- if you need higher ones,
  545. contact me and I'm sure we can work something out. <g>)  The only
  546. requirement for running the game multinode is that you must be running
  547. DOS SHARE or some equivalent (like the built-in file-sharing in OS/2 or
  548. the file-sharing facilities on LANs).  If you're running multinode
  549. *without* such a utility, now would be a good time to start.
  550.  
  551. To set up the door for multinode use, create batch files for each node
  552. like those in the single-node instructions, above.  The only times
  553. different nodes will need *different* batch files are
  554.  
  555. (a) when the game is run across a LAN on which the drive letter for the
  556.     game directory is different for different nodes, and
  557.  
  558. (b) when you are running nodes with non-standard IRQ's under DOS and you
  559.     are *NOT* using a FOSSIL driver.
  560.  
  561. If you have a local node and you like to play the game with RIP
  562. graphics, you may want to have a special batch file for the local node
  563. to bring up the game with the /LRIP parameter.
  564.  
  565. (If you are running a multiline system where the node number is not
  566. included in the door information file, like RemoteAccess with
  567. DORINFO1.DEF, you will either need to use multiple batch files or use an
  568. environment variable to specify the node number with the /N option.  See
  569. "COMMAND-LINE ARGUMENTS," above.)
  570.  
  571. Iron Ox includes a multinode chat/messaging system.  By default,
  572. Iron Ox looks for up to ten nodes on your system.  If you have more
  573. nodes than that (or if you have considerably fewer, and you want to save
  574. your CPU a little work) you can visit the Multinode Menu in OxConfig and
  575. adjust your Highest Node Number.
  576.  
  577. One more thing for DOS users:  When you first enter OxConfig, you will
  578. see a message about IRONOX.EXE being flagged read-only.  This is a
  579. workaround to cope with a bug in Borland's overlay manager, and should
  580. have no effect on day-to-day use of the game.  If you should ever need
  581. to reverse the process (to upgrade or remove IRONOX.EXE), type the
  582. command ATTRIB IRONOX.EXE -R from the DOS prompt.  This issue does not
  583. come up under OS/2.
  584.  
  585. That's all it takes!  Iron Ox uses lock files to control simultaneous
  586. use of files, so resources may remain locked if the system crashes while
  587. someone is in the door.  However, each node clears all of its locks
  588. every time it enters or exits the door normally, so "lingering locks"
  589. will be cleared automatically.  If you ever need to clear the lockfiles
  590. manually, you can do so by typing "DEL C:\DOOR\IRONOX\*.L*" (though this
  591. will delete your Iron Ox logfiles, too).
  592.  
  593.                             COMMON PROBLEMS
  594.  
  595. 1. My BBS makes one of the dropfiles the door supports, but the game
  596.    keeps telling me it can't find a dropfile!
  597.  
  598.    This game assumes that you are running it from the directory where
  599.    your BBS dropfile is located.  If you aren't, include the directory
  600.    where your dropfile is located on the command line, thus:
  601.  
  602.    C:\DOOR\IRONOX\IRONOX.EXE C:\WC30\WCWORK\NODE1\
  603.  
  604.    If you're running a DORINFO system, specifying the node number on the
  605.    command line might also be useful:
  606.  
  607.    C:\DOOR\IRONOX\IRONOX.EXE /N:3 C:\QBBS\
  608.  
  609. 2. The game works fine locally, but doesn't work over a modem!
  610.  
  611.    If you're running under DOS and you're having trouble getting serial
  612.    support to work, one good solution is to try a FOSSIL driver.  FOSSIL
  613.    drivers are an excellent choice for high-performance communications,
  614.    and can (if you wish) be loaded and unloaded from the batch file that
  615.    executes Iron Ox.  If you do not have a FOSSIL driver, they are
  616.    available from my system (listed under "Support," below), and many
  617.    other places as well.
  618.  
  619.    If you don't wish to use a FOSSIL, the /ACCEPT, /LOCK, /P and /I
  620.    options explained in the section on command-line arguments may help
  621.    with the problem.  If not, or if you're already *using* a FOSSIL and
  622.    are still having problems, feel free to contact me for further
  623.    assistance.
  624.  
  625. 3. I'm running Iron Ox for OS/2, and I keep getting a "critical error
  626.    setting DCB" or something like that whenever the game tries to run
  627.    across a modem!
  628.  
  629.    Usually, this error means that Iron Ox is trying to open the wrong
  630.    comm port or a comm port that doesn't exist.  There are two common
  631.    causes for this:
  632.  
  633.    (a) you're using the /PORT parameter when you shouldn't be or not
  634.        using it when you should be, or
  635.  
  636.    (b) the door is finding the wrong dropfile.
  637.  
  638.    If you're running a DOS BBS in a VDM, you need to use the /PORT
  639.    parameter.  If you're running a native OS/2 BBS, you may or may not
  640.    need it:  try removing it/adding it.  If fixing your /PORT setting
  641.    doesn't address the problem, try specifying the location/name of the
  642.    door dropfile on the command line.
  643.  
  644. 4. I'm running the DOS version of the game.  The game runs fine
  645.    single-node, but if two people try to go in at once, I get a sharing
  646.    violation!
  647.  
  648.    As I say in the section on multinode setup, the Borland C overlay
  649.    manager has a bug that causes sharing violations when you try to run
  650.    an overlaid program multinode.  The work-around for this problem is
  651.    to flag your IRONOX.EXE file read-only; you can do this by running
  652.    OxConfig, or by using ATTRIB IRONOX.EXE +R.
  653.  
  654. 5. The game is getting confused about what node it's running on!
  655.  
  656.    Iron Ox is designed to figure out the node ID on which it's running
  657.    from the BBS drop file.  On some systems, however, determining the
  658.    node ID from the drop file is not possible.  See the documentation
  659.    for the "/N" command-line parameter, above.  If you're using /N and
  660.    Iron Ox is *still* getting confused, chances are that Ox is
  661.    finding a stray dropfile.  Try specifying the name and location of
  662.    the dropfile on the command-line (as described above).
  663.  
  664. 6. I run under DOS, and I'm getting some weird message about SHARE not
  665.    being loaded!
  666.  
  667.    If you're running Iron Ox multinode, you need to have SHARE (or an
  668.    equivalent utility) loaded.  Consult your operating system manual for
  669.    information on using SHARE.
  670.  
  671.    If you're not running multinode, you shouldn't need to have SHARE
  672.    loaded on your system.  Go into OxConfig, visit the Multinode Options
  673.    menu (under "General Options") and set your "Highest Node Number" to
  674.    zero.  (Actually, you probably won't even get as far as the main menu
  675.    -- OxConfig will detect the problem with SHARE and prompt you to turn
  676.    off multinode support as soon as you run the program.)
  677.  
  678.                           CONFIGURING IRON OX
  679.  
  680. The easiest way to configure Iron Ox is to use the OxConfig utility
  681. included with Ox.  This utility allows you to edit values in your
  682. IRONOX.CFG file, and includes range-checking and online help.  If you
  683. prefer to edit IRONOX.CFG (an ASCII file) manually, see IRONOX.SAM for
  684. information on the options in the file.
  685.  
  686. Note:  If you are running an interBBS league and have relatively
  687. complicated routing (more than one hub, numerous routing exceptions),
  688. you may need to edit the routing section of your IRONOX.CFG manually.
  689. Information about IBBS routing appears in IRONOX.SAM and INTERBBS.DOC.
  690.  
  691.                               CUSTOMIZING
  692.  
  693. The following information is for "power users" only. <g>  None of the
  694. customization described in this section is strictly necessary.
  695.  
  696. Iron Ox reads and uses two ASCII text files in your IRONOX directory
  697. other than IRONOX.CFG:
  698.  
  699. 1. CONTESTS.TXT -- This file is a straightforward list of the titles
  700.    used for the Colony Cultural Competition.  By default, it includes
  701.    the following entries:
  702.  
  703.    Bad Poetry
  704.    (Clean) Limerick
  705.    ASCII Art
  706.    Annoying Pun
  707.    Political Tirade
  708.    Interesting Trivia
  709.  
  710.    So long as you leave at least one choice on the list, you may add or
  711.    delete entries as you like (Ox chooses randomly from the entries on
  712.    the list whenever it creates the game).  The maximum length for
  713.    contest names is 30 characters.
  714.  
  715. 2. EXCLUDES.TXT -- This file is not included in your Iron Ox archive --
  716.    if you want it, you need to create it.
  717.  
  718.    In the registered version of Ox, the game can award time prizes to
  719.    the player with the highest daily, weekly, and monthly score.
  720.    Obviously, users with extremely large daily time limits (the sysop
  721.    and any co-sysops) have no need for time prizes.  By excluding such
  722.    people from contention for time prizes, you can stimulate more
  723.    interest in the prizes.
  724.  
  725.    EXCLUDES.TXT can include up to ten names (one per line, ASCII text)
  726.    of people to be excluded from winning time prizes.
  727.  
  728.                            EXTERNAL PROTOCOLS
  729.  
  730. Iron Ox supports automatic in-game downloading of RIP icon files.  To
  731. activate this option, visit OxConfig's General Settings|General Config
  732. menu and entered a valid path and filename for an external protocol.
  733.  
  734. One important caveat about Iron Ox's use of external protocols.  The
  735. MS-DOS version of Iron Ox assumes that any protocol will use a
  736. DSZ-style command line:
  737.  
  738.    dsz port 1 sz @files.lst
  739.  
  740. The OS/2 version assumes that any protocol will use a CEXYZ/2-style
  741. command line:
  742.  
  743.    cexyz2 /P12 /B38400 /Sz @files.lst
  744.  
  745. Note that the CEXYZ/2 command line includes a comm handle, not the name
  746. of a comm port to open.
  747.  
  748. Iron Ox has been tested with DSZ and CEXYZ/2, and those protocols are
  749. recommended.  If you are using a protocol other than DSZ/CEXYZ/2 that
  750. uses a similar command line, you may be able to run that protocol by
  751. entering a batch file name in OxConfig and using that batch file to
  752. "translate" the command line arguments.
  753.  
  754.                           MAINTAINING IRON OX
  755.  
  756. In the installation instructions (above), you read about how to use
  757. IRONOX /MAINT in your nightly maintenance batch file to advance the game
  758. to new turns.  You also will need to run IRONOX /RESET to create new
  759. game files when the game comes to an end (by default, this will only
  760. happen every few months).
  761.  
  762. In general, that's all the maintenance you'll need to do!  If you have a
  763. problem user and you need to delete him/her or edit an alias, running
  764. IRONOX /LOCAL /EDIT calls up a very minimal editor that includes this
  765. function.  As you may know, Iron Ox 1.x and 2.x included a much more
  766. complete game editor.  However, because Iron Ox 3.x is intended to run
  767. interBBS, and because accusations of cheating are so common in interBBS
  768. leagues, a comprehensive editor is not included in this version, and the
  769. data files were encrypted to discourage direct modification.
  770.  
  771.                               ERRORLEVELS
  772.  
  773. In case your BBS software reads and uses errorlevels on door exit, here
  774. are the errorlevels Iron Ox returns:
  775.  
  776.      0   -   Critical error has occurred!
  777.      1   -   The user has dropped carrier.
  778.      2   -   The sysop has terminated the call; user off-line.
  779.      3   -   User time has expired; still on-line.
  780.      4   -   Keyboard inactivity timeout; user off-line.
  781.      10  -   Normal exit; user on-line.
  782.     255  -   Program integrity problem; please check log and contact me!
  783.  
  784.                     LICENSE/REGISTRATION INFORMATION
  785.  
  786. This program is copyrighted shareware.  You are licensed to try this 
  787. program for up to 30 days.  After 30 days, if you elect to continue
  788. using Iron Ox, you must register.
  789.  
  790. The game costs only $20.  If you wish to register using a credit card,
  791. you can use your modem to call 619-462-8406 or 619-462-7146 to obtain
  792. your registration key *INSTANTLY* using online registration.  (Note:  To
  793. do this, you have to go through my normal questionnaire/login process.
  794. If you're concerned about long distance expenses -- e.g., if you're
  795. calling internationally -- see INTLREG.DOC for instructions on how to
  796. work around that!)  If you prefer to use conventional mail and a check
  797. or money order, see REGISTER.FRM for information on shipping and
  798. delivery options.
  799.  
  800. Iron Ox is not "crippleware":  the unregistered version is a complete
  801. and enjoyable game.  However, the registered version of Ox does include
  802. the following enhanced features:
  803.  
  804. 1. MORE LAND IMPROVEMENTS:  In the registered version of the game, your
  805.    players are allowed to build three powerful improvements (the luxite
  806.    refinery, ore refinery, and power plant) that noticeably improve
  807.    production of luxite, ore, and energy.  Because these improvements
  808.    are "unique" -- each colony may only have one of them! -- the battle
  809.    over who controls them can add extra excitement to the game.
  810.  
  811. 2. EXTRA RACES:  In the registered version of the game, three extra,
  812.    specialized races are available to players:  the Photovore, a
  813.    sunlight-eating alien who specializes in plants and energy-making;
  814.    the Rubblemuncher, an amazing ore-miner who's allergic to luxite; and
  815.    the Metamorph, a creature who can actually *change shape* and assume
  816.    the abilities of different races during the course of the game.
  817.  
  818. 3. EXPERT AND NIGHTMARE MODES:  In the evaluation version, you may only
  819.    choose beginner and intermediate skill levels for the game.  In the
  820.    registered version, you can give your players an extra challenge by
  821.    selecting expert or nightmare mode!
  822.  
  823. 4. TIME PRIZES:  If you own the registered version and use BBS software
  824.    that "reads back messages" from doors, you can set (totally optional) 
  825.    daily, weekly, and/or monthly time prizes for the leaders in the 
  826.    standings!  This feature works on Wildcat! (3.x USERINFO.DAT and 4.x
  827.    SYSINFO.DAT), RemoteAccess, Apex, and QuickBBS (EXITINFO.BBS), and
  828.    many other systems.
  829.  
  830. 5. TROJAN OXEN:  Trojan Oxen are a valuable defense against sabotage:
  831.    They look like ordinary oxen, but *fight back* if attacked.  Very
  832.    helpful in cutthroat games.
  833.  
  834. Please see REGISTER.FRM to find out how to register your copy of Iron
  835. Ox.  Iron Ox is the product of countless hours of work.  I need your
  836. help to continue developing enhancements and new features.
  837.  
  838.                        ADDITIONAL LICENSE INFO
  839.  
  840. You are allowed (and encouraged) to distribute unmodified copies of Iron
  841. Ox so long as you distribute the complete archive with all files intact.
  842. You may include unmodified, complete archive versions of the shareware
  843. edition of Iron Ox in software collections (e.g., CD-ROMs) so long as
  844. the documentation for the collection clearly indicates that it contains
  845. shareware products and that the purchase of the collection does not
  846. constitute a license for the use of said products.
  847.  
  848. Registration of this product entitles you to a unique registration code
  849. keyed to your name and the name of your BBS.  This key will allow you
  850. and your system's users to access the registered-only features of the
  851. program, and will deactivate all messages to the effect that the program
  852. is an "Unregistered Evaluation Copy."  Your registration is good for all
  853. future releases of Iron Ox for DOS and OS/2:  If I should ever need to
  854. change the key system, you as a registered user will be entitled to
  855. receive a working new key on request via U.S. Mail or electronic mail.
  856.  
  857. Registrations are non-transferable without my direct permission.
  858.  
  859.                               SUPPORT
  860.  
  861. I appreciate your feedback and ideas.  If you have problems getting Iron
  862. Ox to run, please feel free to contact me.
  863.  
  864. I am moderator of the Fidonet IRONOX echo, which is distributed via the
  865. Zone 1 echomail backbone.  This echo is an excellent place to get help
  866. with the game, discuss improvements for future versions, and get access
  867. to game tips for your players!  Please note:  I attempt to read all of
  868. my personal mail regularly.  However, due to the large volume of mail I
  869. receive, I do sometimes get behind.  If you need a reply from me
  870. quickly, please feel free to e-mail or crashmail me, but also consider
  871. posting a public message in the IRONOX echo.  Many knowledgeable people
  872. read that area, and may be able to provide fast answers.
  873.  
  874. I also monitor the Fidonet DOORWARE, DOORGAMES and ON_LINE_GAMES
  875. conferences for *personal* mail (please address it to "JOEL DOWNER" if
  876. you want a reply from me!).  I also monitor the General Mail and Ox
  877. Local Support conferences on my BBS for personal mail.
  878.  
  879. I can be reached via netmail at Fidonet address 1:202/704.  I am also
  880. reachable via the Internet as joel@dreamcty.cts.com.
  881.  
  882. The support BBS for Iron Ox, and for all software by Joel Downer, is The
  883. Dreaming City.  The Dreaming City has two lines:
  884.  
  885. Node 1:  USR Courier "V.Everything" 28.8 (619) 462-8406
  886. Node 2:  ZyXEL 16.8 v.32bis              (619) 462-7146
  887.  
  888. The latest version of Iron Ox for DOS and for OS/2 is available for
  889. download on my BBS, for FREQ (magic names:  IRONOX for the DOS version,
  890. OX2 for the OS/2 version) from either of my Fido nodes, and for
  891. anonymous ftp from ftp.cts.com, in the /pub/joeld directory.  Iron Ox
  892. also has a home page on the World Wide Web, at
  893.  
  894.    http://www.free.cts.com/crash/j/joeld/ox.html
  895.  
  896. The WWW page is a new experiment, and I welcome your feedback. :-)  It
  897. includes information on recent development, future plans, and more!
  898.  
  899.                      IRON OX DISTRIBUTION SITES
  900.  
  901. The following bulletin board systems are official distribution sites for
  902. Iron Ox and any necessary companion programs.  Note:  This information
  903. was compiled in July 1995; some of these telephone numbers will change
  904. over time.  If you find that the numbers listed for systems in your area
  905. are no longer accurate, you may be able to find up-to-date information
  906. in a current FidoNet nodelist.
  907.  
  908. BBS System         Fido Addr   Telephone     Modem        Where
  909.  
  910. The Dreaming City  1:202/704   619-462-8406  28.8 Dual    La Mesa, CA
  911. TDC 2              1:202/705   619-462-7146  16.8 V.32bis La Mesa, CA
  912. Common Sense       1:215/705   510-713-7336  V.34+ Dual   Newark, CA
  913. Comp. Connection   1:157/574   216-671-2574  V.34+ Dual   Cleveland, OH
  914. EVIL DEAD BBS      1:3550/566  907-278-3845  V.FC 28.8    Anchorage, AK
  915. The Harry Beast    1:343/102   206-859-6157  V.32bis      Kent, WA
  916. Hole in the Wall   1:104/651   303-841-5515  28.8 Dual    Parker, CO
  917. Holston River Vlly 1:3615/42   615-932-1490  28.8 Dual    Knoxville, TN
  918. Holston 2          1:3615/43   615-932-1492  28.8 Dual    Knoxville, TN
  919. Mayberry BBS       1:3663/302  910-789-8183  28.8 Hayes   Mt. Airy, NC 
  920. Test Pattern BBS   1:259/524   905-890-2531  28.8 Dual    Ontario, Canada
  921. Ruby's Joint       1:112/129   904-777-6799  28.8 Hayes   Jacksonville, FL
  922.  
  923.                     OTHER SOFTWARE BY JOEL W. DOWNER
  924.  
  925. Fiction Factory   Fiction Factory is a "never-ending story" door aimed
  926.                   at the modern BBS.  It includes full RIP support
  927.                   (including optional local RIP); a full-screen,
  928.                   scrolling windowed text editor and file viewer;
  929.                   context-sensitive, popup help; real-time multinode
  930.                   support; up to 255 stories at a time; password-
  931.                   protected stories; and more!
  932.  
  933.                   File:  FFCV100.ZIP (DOS Version), Magic Name:  FICTFACT
  934.                   File:  FFC2V100.ZIP (OS/2 Version), Magic Name:  FF2
  935.  
  936. Doors/2           Doors/2 is a complete toolkit for developing C/C++
  937.                   doors for OS/2.  It's based on the OpenDoors API, and
  938.                   allows you to port a DOS door written for OpenDoors
  939.                   with little more than a recompile!  Features include
  940.                   32-bit multithreaded performance, full support for a
  941.                   wide range of BBS'es/dropfiles, built-in multinode
  942.                   messaging and chat, full-screen editing capabilities,
  943.                   and more!
  944.  
  945.                   File:  DRS2V5B5.ZIP, Magic Name:  DOORS2
  946.  
  947.                              DISCLAIMER
  948.  
  949. I make no warranty of any kind regarding the usefulness, reliability,
  950. merchantability, or fitness of this software and documentation for any
  951. purpose whatsoever.  While I have tested this program thoroughly, I
  952. cannot and will not make any promises that the program will run well or
  953. safely on your hardware or with your particular software configuration.
  954. This software is guaranteed only to take up disk space, and I make no
  955. absolute guarantee that it will do a reliable job of that.
  956.  
  957. Your use of Iron Ox and/or any companion material constitutes your
  958. acceptance of these terms.
  959.  
  960.                           ACKNOWLEDGEMENTS
  961.  
  962. To paraphrase J.R.R. Tolkien, Iron Ox is a tale that has grown in the
  963. telling.  When I wrote the first version of Iron Ox in the Fall of 1993,
  964. I don't think I could have imagined that it would some day have features
  965. like local graphics, interBBS support, and real-time multinode
  966. interaction.
  967.  
  968. Credit for the continued growth of the door belongs to many people who
  969. have provided inspiration, encouragement, or concrete help along the
  970. way.  Please see the HISTORY.TXT file for a specific list of heroes who
  971. have made a big difference in the creation of this version.
  972.  
  973. Iron Ox's support for RIP uses a C RIP library that is (loosely) based
  974. on Tom Morgan's Pascal RIPLink library.  Thanks to Tom, and to the
  975. maintainers of DDPlus -- Steve Lorenz and Bob Dalton -- for making
  976. RIPLink and the DDPlus tookit, in which RIPLink is now contained,
  977. available in source form to door authors everywhere!
  978.  
  979. The DOS version of this door also uses the OpenDoors C development
  980. system by Brian Pirie.  That system has saved me countless worries about
  981. the details of talking to the modem, reading dropfiles, etc., and I'd
  982. highly recommend it to any C programmer writing a door.  The OS/2
  983. version uses my own Doors/2 port of OpenDoors; see "OTHER SOFTWARE BY
  984. JOEL W. DOWNER" for more information.
  985.  
  986. Finally, thanks to Evvie Vincow for near-lethal persistence.
  987.